Skip to content

Add link-checker workflow source and Glossary Maintainer workflow#167

Merged
dsyme merged 3 commits intomainfrom
fix-consistency-and-add-workflow-1771366953-529f6a06390032e2
Feb 18, 2026
Merged

Add link-checker workflow source and Glossary Maintainer workflow#167
dsyme merged 3 commits intomainfrom
fix-consistency-and-add-workflow-1771366953-529f6a06390032e2

Conversation

@github-actions
Copy link
Contributor

This PR addresses both Phase 1 (consistency checks) and Phase 2 (workflow discovery) of the Daily Repo Goal Achiever task.

Phase 1: Consistency Fix

Fixed a repository inconsistency:

  • Added workflows/link-checker.md: The link-checker workflow existed in .github/workflows/ and had documentation in docs/link-checker.md, but was missing its source file in workflows/. This PR adds the missing workflow source file to maintain consistency across all three layers.

Phase 2: New Workflow Addition

Added Glossary Maintainer workflow from Peli's Agent Factory.

Why This Workflow?

Source: glossary-maintainer.md from github/gh-aw

Merge Rate: 100% (10 out of 10 PRs merged) - Perfect track record

Blog Post: Meet the Workflows: Continuous Documentation

What It Does

The Glossary Maintainer automatically:

  1. Scans recent code changes for new technical terms (daily/weekly)
  2. Identifies project-specific terminology that needs explanation
  3. Updates the project glossary with new terms and definitions
  4. Maintains consistency with existing glossary structure
  5. Creates pull requests with glossary updates

Why It's Valuable

From the blog series, the Glossary Maintainer stood out because:

  • Perfect merge rate: All 10 proposed PRs were merged
  • High value: Keeps terminology documentation synchronized with code changes
  • General applicability: Works with any project that has a glossary
  • Low maintenance: Runs automatically and uses cache memory to avoid duplicate work
  • Consistency: Prevents terminology drift across documentation

Generalization Plan

The original workflow was specific to the gh-aw project. This adaptation:

Removed:

  • Serena MCP server dependency (gh-aw specific)
  • Hard-coded glossary path (docs/src/content/docs/reference/glossary.md)
  • gh-aw specific terminology patterns
  • Project-specific documentation instructions

Generalized:

  • Automatic glossary file discovery (searches common locations)
  • Structure-agnostic (works with alphabetical or categorical organization)
  • Universal term identification based on usage patterns
  • Flexible to work with any repository structure
  • No external tool dependencies beyond standard GitHub tools

Retained:

  • Incremental daily scans + comprehensive Monday full scans
  • Cache memory for tracking processed commits
  • Clear PR descriptions with change summaries
  • Safe-outputs for secure PR creation

Files Changed

  • workflows/link-checker.md - Added missing workflow source
  • workflows/glossary-maintainer.md - New workflow (generalized from gh-aw)
  • docs/glossary-maintainer.md - Documentation page
  • README.md - Added entry in Code Improvement Workflows section

Benefits

The Glossary Maintainer brings:

  1. Automatic terminology maintenance - No manual tracking of new terms
  2. Documentation consistency - Terms stay aligned with code changes
  3. Accessibility - Helps new contributors understand project concepts
  4. Time savings - Eliminates manual glossary updates
  5. Proven track record - 100% merge rate in production use

Testing

This workflow can be tested by:

  1. Compiling it: gh aw compile glossary-maintainer
  2. Running manually: gh aw run glossary-maintainer
  3. Reviewing the generated PR for glossary updates

Note: This workflow will work best in repositories that already have a glossary file, but it can also identify when a glossary would be beneficial and suggest creating one.

AI generated by Daily Repo Goal Achiever

Phase 1 - Consistency Fix:
- Added missing workflows/link-checker.md (docs existed but workflow source was missing)

Phase 2 - New Workflow:
- Added Glossary Maintainer workflow from Peli's Agent Factory
- Perfect 100% merge rate (10/10 PRs) in original repository
- Generalized for any project with glossary/terminology documentation
- Added workflows/glossary-maintainer.md
- Added docs/glossary-maintainer.md
- Updated README.md with new workflow entry

Source: https://github.com/github/gh-aw/blob/v0.45.5/.github/workflows/glossary-maintainer.md
Blog: https://github.github.com/gh-aw/blog/2026-01-13-meet-the-workflows-documentation/

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation enhancement New feature or request factory hygiene labels Feb 17, 2026
@dsyme dsyme marked this pull request as ready for review February 18, 2026 00:03
@dsyme dsyme merged commit ebf240f into main Feb 18, 2026
1 check passed
@dsyme dsyme deleted the fix-consistency-and-add-workflow-1771366953-529f6a06390032e2 branch February 18, 2026 00:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation enhancement New feature or request factory hygiene

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments